跳到主要内容
版本:V3.0

报修管理API


获取报修列表

接口地址

POST /api/v1.0/invoke/open-ability/method/user-commands

请求参数

参数名类型位置必填说明
Content-TypeStringHeader内容类型,值为application/json
AcceptStringHeader接受类型,值为application/json
AuthorizationStringHeaderBearer认证,访问令牌
commandStringBody命令名称
idStringBody命令ID
paramObject<param>Body命令参数

param说明

参数名类型位置必填说明
residence_idStringBody住宅ID

返回参数

参数名类型位置说明
Content-TypeStringHeader内容类型,值为application/json
successBooleanBody判断请求是否成功
true:成功
false:失败
timestampIntegerBody时间戳
result[]Object<result>Body返回结果

result说明

参数名类型位置说明
maintenance_idStringBody报修ID
start_timeStringBody开始时间,UTC
finish_timeStringBody结束时间,UTC
descriptionStringBody描述
contactStringBody联系人
maintenance_picture_url[]StringBody报修图片地址
feedbackStringBody反馈
stateStringBody状态
wait for confirmation:待确认
in progress:进行中
completed:已完成
closed:已关闭
created_timeStringBody创建时间,UTC

请求示例

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "get_maintenance_list",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52"
}
}

成功返回示例

状态码:200

Content-Type: application/json

{
"success": true,
"timestamp": 1540869200562,
"result": [
{
"maintenance_id": "m31adc223cc4b3bedb6bd4742dedcfa52",
"start_time": "2024-01-16 13:32:45",
"finish_time": "2024-01-17 13:32:45",
"description": "test",
"contact": "10086",
"maintenance_picture_url": [
"https://test.akubela.com/p"
],
"feedback": "test",
"state": "in progress",
"created_time": "2024-01-12 13:32:45"
}
]
}

失败返回示例

接口失败返回



获取报修信息

接口地址

POST /api/v1.0/invoke/open-ability/method/user-commands

请求参数

参数名类型位置必填说明
Content-TypeStringHeader内容类型,值为application/json
AcceptStringHeader接受类型,值为application/json
AuthorizationStringHeaderBearer认证,访问令牌
commandStringBody命令名称
idStringBody命令ID
paramObject<param>Body命令参数

param说明

参数名类型位置必填说明
residence_idStringBody住宅ID
maintenance_idStringBody报修ID

返回参数

参数名类型位置说明
Content-TypeStringHeader内容类型,值为application/json
successBooleanBody判断请求是否成功
true:成功
false:失败
timestampIntegerBody时间戳
resultObject<result>Body返回结果

result说明

参数名类型位置说明
start_timeStringBody开始时间,UTC
finish_timeStringBody结束时间,UTC
descriptionStringBody描述
contactStringBody联系人
maintenance_picture_url[]StringBody报修图片地址
feedbackStringBody反馈
stateStringBody状态
wait for confirmation:待确认
in progress:进行中
completed:已完成
closed:已关闭
created_timeStringBody创建时间,UTC

请求示例

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "get_maintenance_info",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52",
"maintenance_id": "m31adc223cc4b3bedb6bd4742dedcfa52"
}
}

成功返回示例

状态码:200

Content-Type: application/json

{
"success": true,
"timestamp": 1540869200562,
"result": {
"start_time": "2024-01-16 13:32:45",
"finish_time": "2024-01-17 13:32:45",
"description": "test",
"contact": "10086",
"maintenance_picture_url": [
"https://test.akubela.com/p"
],
"feedback": "test",
"state": "in progress",
"created_time": "2024-01-12 13:32:45"
}
}

失败返回示例

接口失败返回



创建报修信息

接口地址

POST /api/v1.0/invoke/open-ability/method/user-commands

请求参数

参数名类型位置必填说明
Content-TypeStringHeader内容类型,值为application/json
AcceptStringHeader接受类型,值为application/json
AuthorizationStringHeaderBearer认证,访问令牌
commandStringBody命令名称
idStringBody命令ID
paramObject<param>Body命令参数

param说明

参数名类型位置必填说明
residence_idStringBody住宅ID
start_timeStringBody开始时间,UTC
finish_timeStringBody结束时间,UTC
descriptionStringBody描述
contactStringBody联系人
filename[]StringBody文件名

返回参数

参数名类型位置说明
Content-TypeStringHeader内容类型,值为application/json
successBooleanBody判断请求是否成功
true:成功
false:失败
timestampIntegerBody时间戳
resultObject<result>Body返回结果

result说明

参数名类型位置说明

请求示例

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "create_maintenance_info",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52",
"start_time": "2024-01-16 13:32:45",
"finish_time": "2024-01-17 13:32:45",
"description": "test",
"contact": "10086",
"filename": [
"f8b5a73f8dd84abaa94dcs248be49b0db"
]
}
}

成功返回示例

状态码:200

Content-Type: application/json

{
"success": true,
"timestamp": 1540869200562,
"result": {
"maintenance_id": "m8b5a73f8dd84abaa94dcs248be49b0d1"
}
}

失败返回示例

接口失败返回



删除报修信息

接口地址

POST /api/v1.0/invoke/open-ability/method/user-commands

请求参数

参数名类型位置必填说明
Content-TypeStringHeader内容类型,值为application/json
AcceptStringHeader接受类型,值为application/json
AuthorizationStringHeaderBearer认证,访问令牌
commandStringBody命令名称
idStringBody命令ID
paramObject<param>Body命令参数

param说明

参数名类型位置必填说明
residence_idStringBody住宅ID
maintenance_idStringBody报修ID

返回参数

参数名类型位置说明
Content-TypeStringHeader内容类型,值为application/json
successBooleanBody判断请求是否成功
true:成功
false:失败
timestampIntegerBody时间戳
resultObjectBody返回结果

请求示例

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "delete_maintenance_info",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52",
"maintenance_id": "m8b5a73f8dd84abaa94dcs248be49b0d1"
}
}

成功返回示例

状态码:200

Content-Type: application/json

{
"success": true,
"timestamp": 1540869200562,
"result": {}
}

失败返回示例

接口失败返回



批量删除报修信息

接口地址

POST /api/v1.0/invoke/open-ability/method/user-commands

请求参数

参数名类型位置必填说明
Content-TypeStringHeader内容类型,值为application/json
AcceptStringHeader接受类型,值为application/json
AuthorizationStringHeaderBearer认证,访问令牌
commandStringBody命令名称
idStringBody命令ID
paramObject<param>Body命令参数

param说明

参数名类型位置必填说明
residence_idStringBody住宅ID
maintenances[]Object<maintenance>Body报修信息

maintenance说明

参数名类型位置必填说明
maintenance_idStringBody报修ID

返回参数

参数名类型位置说明
Content-TypeStringHeader内容类型,值为application/json
successBooleanBody判断请求是否成功
true:成功
false:失败
timestampIntegerBody时间戳
resultObjectBody返回结果

请求示例

POST /api/v1.0/invoke/open-ability/method/user-commands

Content-Type: application/json

Accept: application/json

Authorization: Bearer ac45e846ca23ab42c9ae469d988ae32a9

{
"command": "batch_delete_maintenance_info",
"id": "c45e846ca23ab42c9ae469d988ae32a96",
"param": {
"residence_id": "r31adc223cc4b3bedb6bd4742dedcfa52",
"maintenances": [
{
"maintenance_id": "m8b5a73f8dd84abaa94dcs248be49b0d1"
}
]
}
}

成功返回示例

状态码:200

Content-Type: application/json

{
"success": true,
"timestamp": 1540869200562,
"result": {}
}

失败返回示例

接口失败返回